/*
 * The MIT License
 *
 * Copyright 2012 http://generic-toolset.googlecode.com.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.rlpw.swing;

import javax.swing.ListSelectionModel;

interface SelectionMode {

    /** Only one element can be selected at a time.*/
    public static final int SINGLE = ListSelectionModel.SINGLE_SELECTION;
    /** Only one contiguous interval can be selected at a time.*/
    public static final int MULTIPLE = ListSelectionModel.MULTIPLE_INTERVAL_SELECTION;
    /** In this mode, there's no restriction on what can be selected.*/
    public static final int INTERVAL = ListSelectionModel.SINGLE_INTERVAL_SELECTION;

    /**
     * Sets the mode. The following modes are possible:
     * <ul>
     * <li>{@code SINGLE} -
     *   Only one element can be selected at a time. 
     * <li>{@code INTERVAL} -
     *   Only one contiguous interval can be selected at a time.
     * <li>{@code MULTIPLE} -
     *   In this mode, there's no restriction on what can be selected.
     * </ul>
     * 
     * @see #getMode
     */
    public void setMode(int mode);

    /**
     * Returns the current mode.
     *
     * @return the current mode
     * @see #setMode
     */
    public int getMode();
}
